Skip to main content

Getting Started

Welcome! This guide will walk you through contributing to this site. This site uses Markdown for formatting, and the Markdown files are stored in a github repository here. If you are familiar with github, you can download the files to your local machine, edit them, and then push the changes. The website will automatically update in a few minutes once changes are made. However, you can also create and edit files right in your browser.

Making Changes

On the bottom of each page, there is a link that looks like this: Edit this page

Clicking it will take you straight to the source for that page in a new tab. You may be redirected to sign in, but you should end up at a page that looks like this:

vscode.dev

This is visual studio code, an in browser editor. on the left hand side, you will see the explorer, which has all the files and folders that you see on the website. Here you can edit any file, or create a new file:

new file

This site uses Markdown (.md) files for its pages. Markdown files can be just plain text, but you can also specify formatting inside a file. To see what the markdown file will look like on the browser, you can use the shortcut Ctrl + Shift + V For more information about the Markdown Format, see this page. As you make changes in browser, the git sidebar will show what changes you have made.

git changes

Saving your work

You can click on any file in the list of changes to see what changes have been made to that file. At the top there will be a textbox asking for a message. Every time you want to save your work to the website, it needs a commit message, which is a breif message that explains what you changed. Once you have entered a message, you can select Menu>Commit>Commit and Push. This will save your changes, and start a process that updates the website.

git push